home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / renegade / ultra17.zip / ULTRATOP.DOC < prev    next >
Text File  |  1994-06-20  |  13KB  |  356 lines
  1.  
  2.                           ── UltraTop Version 1.7 ──
  3.                    (C)opyright of Killean and BeerWare Utils
  4.  
  5.   ── What is UltraTop?
  6.  
  7.   Simply put, this program is the best top everything utility written today
  8.    for Renegade.  It can handle the top 20 users of the most Posts, Calls,
  9.    Downloads, Uploads, Downloads in K, Uploads in K, best Post Call Ratios,
  10.    best Upload-Download Ratios, as well as showing the last 10 callers and
  11.    their respective info, the top 20 files downloaded from your BBS, and also
  12.    a complete user listing SIX different ways.
  13.  
  14.   Well what makes this program better?  Complete control of what your stat
  15.    screens will look like.  I personally have never seen before a util that
  16.    you can use your own screens util now.  Using my pre-determined MCI codes,
  17.    UT will act kinda like Renegade and replace the corresponding information
  18.    will the corresponding MCI code.
  19.  
  20.   UltraTop is NOT a door.  On my 386-40DX, it takes less than 2 seconds to
  21.    load up, generate all stats, and process 8 different ANSI screens.  This
  22.    speed will easily allow you to run it as an event at night, or more
  23.    appropiately everytime a user logs off your BBS, or even as a quick drop
  24.    door.  The commandline is COMPLETELY configurable to give you any option
  25.    for stat generation and more control of speed at which it operates.
  26.  
  27.  
  28.   ── New in this version
  29.  
  30.    Added new userlist sorting routine:  RANK/USERNOTE order.  This new option,
  31.    '+S6', will sort your user list by their SL level first, and then sort
  32.    for each level by their city/state info.  
  33.  
  34.    Used in conjunction with the +B parameter (use file base only), you can
  35.    now generate upload statistics for one particular file base.  Syntax:
  36.  
  37.      +B<name> +D
  38.  
  39.      will create top number of uploads and top number of uploads in K for
  40.      file base <name>, using the regular (&N and &U) MCI set.
  41.  
  42.    Another new parameter, +C<@,A-Z>, will exclude <@,A-Z> conferences from file
  43.    stat generation.
  44.  
  45.    Added some better SHARE routines, so hopefully I finally fixed most of
  46.    the file conflicts.
  47.  
  48.    Also, I re-wrote some of the more 'influential' routines so you should
  49.    notice a slight speed increase.
  50.  
  51.  
  52.   ── Setup
  53.  
  54.    The setup is pretty simple - edit the ULTRA.CFG text file to meet the
  55.    following criteria:
  56.  
  57.    Line1  :   <path to RG, i.e. C:\RG >
  58.    Line2  :   <REGISTRATION #>
  59.  
  60.    Line3  :   <ansi text file #1>   <output file #1>
  61.     or
  62.    Line3  :   <header> <middle> <footer ansi> <output file #1>
  63.  
  64.      |                 |                   |
  65.  
  66.    Line103:   <ansi text file #100> <output file #100>
  67.  
  68.    The first line is just the path to your Renegade directory (backslash
  69.    doesn't matter), the second is your registration number, and the following
  70.    100 lines contain the full paths to your input ansi file and outfile files.
  71.    Not all of lines between 3 and 103 have to be used (in unregistered versions
  72.    lines after line 3 are read, but not used).  A sample ULTRA.CFG file has
  73.    been provided.
  74.  
  75.    Also, it does not matter what directory you run ULTRATOP from, as long as
  76.    ULTRA.CFG is in the same dir, and the RG path on line 1 is correct.
  77.  
  78.  
  79.   ── The UT Process
  80.  
  81.    First, Ultratop scans the appropiate RG data files to generate the stat
  82.    information.  Next, Ultratop scans the config file for up to 100 different
  83.    input ansi files (unregistered users only get 1), reads each file looking
  84.    for MCI codes, replaces them with the corresponding data, and writes it
  85.    into the output file on the same line in the config.  Pretty Simple.  The
  86.    hard part is making the ansi, since the MCI codes are 4 characters long.
  87.    But I'll get to that in a sec.  I have also included a few sample ansis,
  88.    already configured with the MCI codes.
  89.    
  90.    The following list is the current available runtime paramters (case does
  91.    not matter):
  92.  
  93.      +R     -  Generates the regular (top posters, top PCR, etc.) stats for the
  94.                BBS.
  95.      +L     -  Generates the last callers for the BBS.
  96.  
  97.      +F     -  Generates the most downloaded files stats.
  98.  
  99.      +S#    -  Sort users' listing by:
  100.  
  101.                0: None.  Retains normal user order.
  102.                1: Ascending.  Sort by handle alphabetically A - Z.
  103.                2: Descending.  Sort by handle alphabetically Z - A.
  104.                3: Oldest.  Sort by when user first called.
  105.                4: Most Recent.  Sort by date user last called, latest being
  106.                   first.
  107.                5: Rank.  Sort by SL alphabetically A - Z.
  108.                6: Rank/Usernote.  Sort by SL and alphabetically their city/
  109.                   state info.
  110.  
  111.      +N     -  No statistics generated.  User lists are still generated.
  112.  
  113.      +I##   -  Ignore file number ## in the ULTRA.CFG list.
  114.  
  115.      +O##   -  Use ONLY file number ## in the ULTRA.CFG list.
  116.  
  117.  
  118.      +Ename -  Exclude filebase <name> from the filestats generation.
  119.  
  120.      +Cconf -  Exclude conference (@, and A through Z) from the filestats
  121.                generation.
  122.  
  123.      +Bname -  Use ONLY filebase <name> in the filestats generation.
  124.  
  125.      +D     -  Generate upload stats using filebase defined from the +B
  126.                parameter.
  127.  
  128.      
  129.  
  130.    Running Ultratop WITHOUT any of these parameters will default all three
  131.    main generation sequences, and none of the 'special' sequences.  If you run
  132.    Ultratop WITH parameters, only the ones used will be generated.  For
  133.    example:
  134.  
  135.      Ultratop +R +L +F +EAB
  136.  
  137.    will generate all three stats information using every file and excludes
  138.    any file base that has an ACS defined for conferences A and B, while
  139.  
  140.      Ultratop +L +O2
  141.  
  142.    will only generate the last callers information using only the second
  143.    file listed in ULTRA.CFG, and
  144.  
  145.      Ultratop +S5 +ELocalAns
  146.  
  147.    will sort the users' listing by RANK order and exclude filebase LOCALANS
  148.    from any filstats, but
  149.  
  150.      Ultratop
  151.  
  152.    will generate all three stats as well using every ansi file in the CFG,
  153.    and doesn't exlude anything or sort in any special way.
  154.  
  155.    For the user listing option, UT will generate it every time it comes
  156.    across a 4 parameter line in the ULTRA.CFG file, so you could have
  157.    multiple user listings generated, but they will all be sorted the same
  158.    unless you run UT multiple times.
  159.  
  160.    I implemented these parameters because the top files generation has the
  161.    possiblity of becoming a much more time consuming process than the other
  162.    two parameters, depending mainly on how many file bases you have.  So
  163.    you could possibly run the last callers screen generation and various
  164.    top user screens everytime someone logs off, and then during your nightly
  165.    event generate all the screensusing different parameters.
  166.  
  167.    Its all up to you.
  168.  
  169.  
  170.  
  171.   ── MCI codes
  172.  
  173.    These are the current MCI codes used for UltraTop:
  174.  
  175.  Name:
  176.    &P## :  Top poster
  177.    &C## :  Top caller
  178.    &R## :  Top PCR ratio
  179.    &W## :  Top number of DLs
  180.    &D## :  Top DL in K
  181.    &N## :  Top number of ULs
  182.    &U## :  Top UL in K
  183.    &T## :  Top UL/DL ratio
  184.  
  185.    Each of these correspond to a second set of codes:
  186.  
  187.  Data:
  188.    &p## :  number of posts
  189.    &c## :  number of calls
  190.    &r## :  PCR ratio
  191.    &w## :  number of DLs
  192.    &d## :  number in K of DLs
  193.    &n## :  number of ULs
  194.    &u## :  number in K of ULs
  195.    &t## :  UL/DL ratio
  196.  
  197.    ## stands for the number of the user in the list from 01 to 20, and the
  198.    uppercase codes stand for the users' Names, and the lowercase for the
  199.    users' Data.
  200.  
  201.    So for example, the third Top Poster, followed by his number of posts,
  202.    would be a MCI code of:
  203.  
  204.       &P03 &p03
  205.  
  206.    If the '+D' parameter is used, then the '&N' and '&U' MCIs, as well as their
  207.    corresponding data '&n' and '&u' MCIs, will give the top number of uploads
  208.    and upload in K for whatever base is defined with the '+B' parameter.
  209.  
  210.  
  211.  Last Callers:
  212.  
  213.    ~B## :  baud rate
  214.    ~C## :  city state field
  215.    ~H## :  handle
  216.    ~N## :  caller number
  217.    ~T## :  time logged in at
  218.    ~1## :  user defined answer 1
  219.    ~2## :  user defined answer 2
  220.    ~3## :  user defined answer 3
  221.    ~A## :  total amount of time on system
  222.  
  223.    Almost same as before, the ## represents the last 01 - 10 users available
  224.    to read into your output file.  I used a tilda (~) char to avoid confusion
  225.    from the other stats set.
  226.  
  227.    Also, an important note for this set:
  228.  
  229.    01 refers to the TENTH caller ago, and 10 refers to the MOST RECENT CALLER.
  230.    This usage enhances readability for the output file, for most lists are
  231.    produced and read from the top down.  So if you were to make a ansi for
  232.    the last FIVE callers, you would start with 05 and work your way to 10 in
  233.    the input ansi file, or if you were to make a small ansi for the last caller
  234.    info, you would use 10 for replacing the ## in the code.
  235.  
  236.  
  237.  Top Files:
  238.  
  239.    *N## :  file name
  240.    *T## :  number of times downloded
  241.    *W## :  who uploaded it
  242.    *D## :  date it was uploaded
  243.    *S## :  size of the file
  244.  
  245.    Again, the ## is used to represent 01 through 20 of the list of files most
  246.    downloaded.  For these I used an star '*' character to search for when
  247.    generating the ansis.  I had a percent '%' character before, but the new
  248.    version of renegade changed the MCI codes to that.
  249.  
  250.  
  251.  User Listings:
  252.  
  253.    @H : users' handle
  254.    @C : users' city/state info
  255.    @1 : users' defined answer #1
  256.    @2 : users' defined answer #2
  257.    @3 : users' defined answer #3
  258.    @G : users' gender
  259.    @F : date the user was first on
  260.    @L : date the user was last on
  261.    @S : user's security level (SL)
  262.  
  263.    All these codes are only a length of two characters, since it will traverse
  264.    through the USERS.DAT file generating a line for each validated user from
  265.    the MIDDLE defined ansi.
  266.  
  267.    I recommend saving the MIDDLE and FOOTER ansis with a video preparation of
  268.    NONE (if you use TheDraw), and save the HEADER ansi as CLEAR.  Makes sense.
  269.  
  270.  
  271.    ---------
  272.  
  273.   Most of these different stat sets (&,~,* - NOT @) can be used in a single
  274.    file, but you must remember that with the exception of the '&' stats, they
  275.    only correspond locally to each set.  For example:
  276.  
  277.       &U01   *N01
  278.  
  279.    This is NOT the top uploader followed by the file he uploaded, but it is
  280.    the top uploader followed by the file most downloaded.
  281.  
  282.  
  283.       &D01   &d01   &w01
  284.  
  285.    This is NOT the top downloader followed by his/her downloads in K followed
  286.    by his/her number of downloads.  This example is the top downloader in K's
  287.    NAME, followed by the the top downloader in K's AMOUNT DOWNLOADED, followed
  288.    by the most number of files downloaded, almost certainly by a totally
  289.    different user than the user from &D01.
  290.  
  291.    Just remember that when using the '&' codes, only the same letters, upper
  292.    and lowercase, correspond together (i.e. &D01 and &d01).  For the other
  293.    sets '~' and '*', each code in the set corresponds to a SINGLE user
  294.    depending on the number in the set (##).  For example:
  295.  
  296.       ~B10 ~C10 ~H10 ~N01 ~T10
  297.  
  298.    This example IS the last caller's baud rate, followed by his city/state
  299.    info, followed by his handle (name), followed by what caller number he is,
  300.    followed by the time that he logged on.  ONE user's information.
  301.  
  302.  
  303.   When creating your ansi file, you have to be careful of a couple of things:
  304.  
  305.    First, remeber that a user's handle has a maximum length of 36 characters,
  306.    so you ought to allow room for especially long names.
  307.  
  308.    Second, if you save your ansi under ansimation and save it to a particular
  309.    line length, occasionally the saving process will split the MCI codes if
  310.    it happens to land at the end of the line.  To remedy this, all you have
  311.    to do is edit the ansi with a text editor and just move the codes back
  312.    together, on either line.  When saving these screens, I recommend saving
  313.    them with 'None' as the output line length.
  314.  
  315.    A few ansi files have been provided to give you examples to work from.
  316.  
  317.  
  318.   ── Registration
  319.  
  320.    Registration for this program is a measley 5 bucks.  With this paltry
  321.    amount you get:
  322.  
  323.    - Up to 100 different output files at one run
  324.    - Absense of nag lines
  325.    - Full support from the author
  326.    - 100% free updates in future
  327.  
  328.    To register, send your check, along with your sysop Handle, board infor-
  329.      mation, a phone number, address, or some means of getting in touch with
  330.      you, to:
  331.  
  332.      Steve Kerr
  333.      500 Northside Cir. Apt. LL-12   <------  New Address!!
  334.      Atlanta, GA  30309
  335.  
  336.  
  337.  
  338.    If you have any questions, I can be reached at the following BBS':
  339.  
  340.      Steve Kerr @
  341.      Library of Trantor BBS: 404-920-7711 (sysop: Ben Linebeck)
  342.  
  343.      or
  344.  
  345.      Killean @
  346.      Digital Frontier      : 404-955-5073 (sysop: Cott Lang)
  347.  
  348.      (or at any of the other beerware alpha sites, or my board)
  349.  
  350.  
  351.  
  352.  Good luck,
  353.  
  354.  Killean      - TRiBE / BeerWare Utils
  355.  
  356.